<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic id="topic_vzy_mkx_bpb">
  <title>gpmt</title>
  <body>
    <p> GPMT (Greenplum Magic Tool) provides a set of diagnostic utilities to troubleshoot and
      resolve common supportability issues, along with a consistent method for gathering information
      required by VMware Support.</p>
    <section>
      <title>Synopsis</title>
      <codeblock>gpmt &lt;tool> [&lt;tool_options> ...] 

gpmt -hostfile &lt;FILE>

gpmt -help

gpmt -verbose
</codeblock>
    </section>
    <section>
      <title>Tools</title>
      <sectiondiv><b>Greenplum</b></sectiondiv>
      <parml>
        <plentry>
          <pt><xref href="gpmt-analyze_session.xml" type="topic" format="dita">analyze_session</xref></pt>
          <pd>Collect information from a hung Greenplum Database session for remote analysis.</pd>
        </plentry>
        <plentry>
          <pt><varname>catalogbackup</varname></pt>
          <pd>For VMware Support use only. Back up catalog prior to performing catalog repairs.</pd>
        </plentry>
        <plentry>
          <pt><xref href="gpmt-gp_log_collector.xml" type="topic" format="dita">gp_log_collector</xref>
          </pt>
          <pd>Basic Greenplum Database log collection utility.</pd>
        </plentry>
        <plentry>
          <pt><varname>gpcheckcat</varname></pt>
          <pd>For VMware Support use only. Greenplum Database gpcheckcat log analysis.</pd>
        </plentry>
        <plentry>
          <pt><varname>gpcheckup</varname></pt>
          <pd>For VMware Support use only. Greenplum Database Health Check.</pd>
        </plentry>
        <plentry>
          <pt><xref href="gpmt-gpstatscheck.xml" type="topic" format="dita">gpstatscheck</xref></pt>
          <pd>Check for missing stats on objects used in a query.</pd>
        </plentry>
        <plentry>
          <pt><xref href="gpmt-packcore.xml" type="topic" format="dita">packcore</xref></pt>
          <pd>Package core files into single tarball for remote analysis.</pd>
        </plentry>
        <plentry>
          <pt><varname>primarymirror_lengths</varname></pt>
          <pd>For VMware Support use only. Check whether primary and mirror AO and AOCO relfiles are
            the correct lengths.</pd>
        </plentry>
        <plentry>
          <pt><varname>tablecollect</varname></pt>
          <pd>For VMware Support use only. Collect data and index files for data corruption
            RCA.</pd>
        </plentry>
      </parml>
      <sectiondiv><b>Miscellaneous</b></sectiondiv>
      <parml>
        <plentry>
          <pt><varname>hostfile</varname></pt>
          <pd>Generate hostfiles for use with other tools.</pd>
        </plentry>
        <plentry>
          <pt><varname>replcheck</varname></pt>
          <pd>Check whether tool is replicated to all hosts.</pd>
        </plentry>
        <plentry>
          <pt><varname>replicate</varname>
          </pt>
          <pd>Replicate tool to all hosts.</pd>
        </plentry>
        <plentry>
          <pt><varname>version</varname></pt>
          <pd>Display the GPMT version.</pd>
        </plentry>
      </parml>
    </section>
    <section>
      <title>Global Options</title>
      <parml>
        <plentry>
          <pt><varname>-hostfile</varname></pt>
          <pd>Limit the hosts where the tool will be run.</pd>
        </plentry>
        <plentry>
          <pt><varname> -help</varname></pt>
          <pd>Display the online help.</pd>
        </plentry>
        <plentry>
          <pt><varname> -verbose</varname></pt>
          <pd>Print verbose log messages.</pd>
        </plentry>
      </parml>
    </section>
    <section>
      <title>Examples</title>
      <p><b>Display gpmt version</b></p>
      <codeblock>gpmt version</codeblock>
      <p><b>Collect a core file</b></p>
      <codeblock>gpmt packcore -cmd collect -core core.1234</codeblock>
      <p><b>Show help for a specific tool</b></p>
      <codeblock>gpmt gp_log_collector -help</codeblock>
    </section>
  </body>
</topic>
